oracle.AWXML
Class MeasureFolder

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.MeasureFolder

public class MeasureFolder

extends BaseObject

A collection of Measure objects. You use a MeasureFolder to group measures according to the needs of your application. For example, you might create separate MeasureFolder objects for financials, sales, and human resources. To create a MeasureFolder, use the createMeasureFolder of an AW object.

You can assign Measure objects that are owned by different Cube objects to the same MeasureFolder. You can group Measure objects in a MeasureFolder, but the MeasureFolder does not own the Measure objects. A Measure is owned by a Cube.

A MeasureFolder can own another MeasureFolder, so that you can nest one or more MeasureFolder objects under a MeasureFolder. The MeasureFolder class does not participate in the object model hierarchy.

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

MeasureFolder()
Creates a MeasureFolder.

MeasureFolder(BaseObject input)
Creates a MeasureFolder for the specified parent MeasureFolder.

Method Summary

void	addMeasure(Measure input) Adds the specified Measure to the MeasureFolder.
void	addMeasureFolder(MeasureFolder input) Adds the specified MeasureFolder to this MeasureFolder.
java.lang.String	Create(AWConnection connection) Creates the MeasureFolder in the current analytic workspace of the specified database connection.
MeasureFolder	createMeasureFolder() Creates a MeasureFolder that is owned by this MeasureFolder.
java.lang.String	Delete(AWConnection connection) Deletes the MeasureFolder in the current analytic workspace of the specified database connection.
java.lang.String	getId() Gets the identifier of the MeasureFolder.
java.util.Vector	getMeasureFolders() Gets a list of the MeasureFolder objects that are owned by this MeasureFolder.
java.util.Vector	getMeasures() Gets a list of the Measure objects associated with the MeasureFolder.
void	removeMeasure(Measure input) Removes the specified Measure from the MeasureFolder.
void	removeMeasureFolder(MeasureFolder input) Removes the specified MeasureFolder from this MeasureFolder.
java.lang.String	WriteToXML() Gets an XML representation of the MeasureFolder.

Methods inherited from class oracle.AWXML.BaseObject

Alter, CreateAfter, CreateBefore, CreateFirst, DataRead, getColumnName, getLongName, getLongName, getName, getOwner, getPluralName, getPluralName, getSchema, getShortName, getShortName, setColumnName, setLongName, setLongName, setName, setPluralName, setPluralName, setSchema, setShortName, setShortName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MeasureFolder

public MeasureFolder()

Creates a MeasureFolder.

MeasureFolder

public MeasureFolder(BaseObject input)

Creates a MeasureFolder for the specified parent MeasureFolder.

Parameters:

input - The MeasureFolder to own the new MeasureFolder.

Method Detail

getId

public java.lang.String getId()

Gets the identifier of the MeasureFolder. The identifier is the full name of the MeasureFolder in the format owner.name.type. As examples, the identifier of a MeasureFolder with the name SALES is SALES.MEASUREFOLDER. The identifier of a nested MeasureFolder with the name ACCOUNT1 that is owned by SALES is SALES.ACCOUNT1.MEASUREFOLDER.

Overrides:

getId in class BaseObject

Returns:

A String that contains the identifier of the MeasureFolder.

createMeasureFolder

public MeasureFolder createMeasureFolder()

Creates a MeasureFolder that is owned by this MeasureFolder.

Returns:

The nested MeasureFolder that is owned by this MeasureFolder.

addMeasureFolder

public void addMeasureFolder(MeasureFolder input)

Adds the specified MeasureFolder to this MeasureFolder.

Parameters:

input - The MeasureFolder to add to this MeasureFolder.

removeMeasureFolder

public void removeMeasureFolder(MeasureFolder input)

Removes the specified MeasureFolder from this MeasureFolder.

Parameters:

input - The MeasureFolder to remove from this MeasureFolder.

getMeasureFolders

public java.util.Vector getMeasureFolders()

Gets a list of the MeasureFolder objects that are owned by this MeasureFolder.

Returns:

A Vector of MeasureFolder objects.

addMeasure

public void addMeasure(Measure input)

Adds the specified Measure to the MeasureFolder.

Parameters:

input - The Measure to add.

removeMeasure

public void removeMeasure(Measure input)

Removes the specified Measure from the MeasureFolder.

Parameters:

input - The Measure to remove.

getMeasures

public java.util.Vector getMeasures()

Gets a list of the Measure objects associated with the MeasureFolder.

Returns:

A Vector of Measure objects.

WriteToXML

public java.lang.String WriteToXML()

Gets an XML representation of the MeasureFolder.

Overrides:

WriteToXML in class BaseObject

Returns:

An XML String that represents the MeasureFolder.

Create

public java.lang.String Create(AWConnection connection)

Creates the MeasureFolder in the current analytic workspace of the specified database connection. To create a MeasureFolder, an application should use the createMeasureFolder of an AW object.

Overrides:

Create in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

A String that contains success if this method successfully creates the MeasureFolder.

Delete

public java.lang.String Delete(AWConnection connection)

Deletes the MeasureFolder in the current analytic workspace of the specified database connection.

Overrides:

Delete in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

A String that contains success if this method successfully deletes the MeasureFolder.